<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pypln.ez_setup</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pypln-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/pypln">Project Homepage</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="pypln-module.html">Package&nbsp;pypln</a> ::
        Module&nbsp;ez_setup
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module ez_setup</h1><p class="nomargin-top"><span class="codelink"><a href="pypln.ez_setup-pysrc.html">source&nbsp;code</a></span></p>
<p>Bootstrap setuptools installation</p>
  <p>If you want to use setuptools in your package's setup.py, just include
  this file in the same directory with it, and add this to the top of your 
  setup.py:</p>
<pre class="literalblock">
   from ez_setup import use_setuptools
   use_setuptools()
</pre>
  <p>If you want to require a specific version of setuptools, set a 
  download mirror, or use an alternate download directory, you can do so by
  supplying the appropriate options to ``use_setuptools()``.</p>
  <p>This file can also be run as a script to install or upgrade 
  setuptools.</p>

<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="_validate_md5"></a><span class="summary-sig-name">_validate_md5</span>(<span class="summary-sig-arg">egg_name</span>,
        <span class="summary-sig-arg">data</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pypln.ez_setup-pysrc.html#_validate_md5">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pypln.ez_setup-module.html#use_setuptools" class="summary-sig-name">use_setuptools</a>(<span class="summary-sig-arg">version</span>=<span class="summary-sig-default">DEFAULT_VERSION</span>,
        <span class="summary-sig-arg">download_base</span>=<span class="summary-sig-default">DEFAULT_URL</span>,
        <span class="summary-sig-arg">to_dir</span>=<span class="summary-sig-default">os.curdir</span>,
        <span class="summary-sig-arg">download_delay</span>=<span class="summary-sig-default">15</span>)</span><br />
      Automatically find/download setuptools and make it available on 
      sys.path</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pypln.ez_setup-pysrc.html#use_setuptools">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pypln.ez_setup-module.html#download_setuptools" class="summary-sig-name">download_setuptools</a>(<span class="summary-sig-arg">version</span>=<span class="summary-sig-default">DEFAULT_VERSION</span>,
        <span class="summary-sig-arg">download_base</span>=<span class="summary-sig-default">DEFAULT_URL</span>,
        <span class="summary-sig-arg">to_dir</span>=<span class="summary-sig-default">os.curdir</span>,
        <span class="summary-sig-arg">delay</span>=<span class="summary-sig-default">15</span>)</span><br />
      Download setuptools from a specified location and return its filename</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pypln.ez_setup-pysrc.html#download_setuptools">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="main"></a><span class="summary-sig-name">main</span>(<span class="summary-sig-arg">argv</span>,
        <span class="summary-sig-arg">version</span>=<span class="summary-sig-default">DEFAULT_VERSION</span>)</span><br />
      Install or upgrade setuptools and EasyInstall</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pypln.ez_setup-pysrc.html#main">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="update_md5"></a><span class="summary-sig-name">update_md5</span>(<span class="summary-sig-arg">filenames</span>)</span><br />
      Update our built-in md5 registry</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pypln.ez_setup-pysrc.html#update_md5">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="DEFAULT_VERSION"></a><span class="summary-name">DEFAULT_VERSION</span> = <code title="&quot;0.6c9&quot;">&quot;0.6c9&quot;</code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pypln.ez_setup-module.html#DEFAULT_URL" class="summary-name">DEFAULT_URL</a> = <code title="&quot;http://pypi.python.org/packages/%s/s/setuptools/&quot; % sys.version [: 3]">&quot;http://pypi.python.org/packages/%s/s/setuptools<code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pypln.ez_setup-module.html#md5_data" class="summary-name">md5_data</a> = <code title="{'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca', 'se\
tuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb', 'setupt\
ools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b', 'setuptools\
-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a', 'setuptools-0.6\
b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618', 'setuptools-0.6b3-p\
y2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac', 'setuptools-0.6b4-py2.3\
.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5', 'setuptools-0.6b4-py2.4.egg\
': '4cb2a185d228dacffb2d17f103b3b1c4', 'setuptools-0.6c1-py2.3.egg': '\
...">{'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b9<code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="use_setuptools"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">use_setuptools</span>(<span class="sig-arg">version</span>=<span class="sig-default">DEFAULT_VERSION</span>,
        <span class="sig-arg">download_base</span>=<span class="sig-default">DEFAULT_URL</span>,
        <span class="sig-arg">to_dir</span>=<span class="sig-default">os.curdir</span>,
        <span class="sig-arg">download_delay</span>=<span class="sig-default">15</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pypln.ez_setup-pysrc.html#use_setuptools">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Automatically find/download setuptools and make it available on 
  sys.path</p>
  <p>`version` should be a valid setuptools version number that is 
  available as an egg for download under the `download_base` URL (which 
  should end with a '/').  `to_dir` is the directory where setuptools will 
  be downloaded, if it is not already available.  If `download_delay` is 
  specified, it should be the number of seconds that will be paused before 
  initiating a download, should one be required.  If an older version of 
  setuptools is installed, this routine will print a message to 
  ``sys.stderr`` and raise SystemExit in an attempt to abort the calling 
  script.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="download_setuptools"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">download_setuptools</span>(<span class="sig-arg">version</span>=<span class="sig-default">DEFAULT_VERSION</span>,
        <span class="sig-arg">download_base</span>=<span class="sig-default">DEFAULT_URL</span>,
        <span class="sig-arg">to_dir</span>=<span class="sig-default">os.curdir</span>,
        <span class="sig-arg">delay</span>=<span class="sig-default">15</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pypln.ez_setup-pysrc.html#download_setuptools">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Download setuptools from a specified location and return its 
  filename</p>
  <p>`version` should be a valid setuptools version number that is 
  available as an egg for download under the `download_base` URL (which 
  should end with a '/'). `to_dir` is the directory where the egg will be 
  downloaded. `delay` is the number of seconds to pause before an actual 
  download attempt.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-VariablesDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="DEFAULT_URL"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">DEFAULT_URL</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
&quot;http://pypi.python.org/packages/%s/s/setuptools/&quot; % sys.version [: 3]
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<a name="md5_data"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">md5_data</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
{'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca', 'se<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
tuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb', 'setupt<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
ools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b', 'setuptools<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a', 'setuptools-0.6<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618', 'setuptools-0.6b3-p<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
y2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac', 'setuptools-0.6b4-py2.3<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5', 'setuptools-0.6b4-py2.4.egg<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
': '4cb2a185d228dacffb2d17f103b3b1c4', 'setuptools-0.6c1-py2.3.egg': '<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pypln-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/pypln">Project Homepage</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Tue Jul 26 17:13:12 2011
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
